<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        
        
        
        <link rel="shortcut icon" href="../../img/favicon.ico">
        <title>用户 - Mall Docs</title>
        <link href="../../css/bootstrap.min.css" rel="stylesheet">
        <link href="../../css/font-awesome.min.css" rel="stylesheet">
        <link href="../../css/base.css" rel="stylesheet">
        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">

        <script src="../../js/jquery-1.10.2.min.js" defer></script>
        <script src="../../js/bootstrap.min.js" defer></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
        <script>hljs.initHighlightingOnLoad();</script> 
    </head>

    <body>
        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
            <div class="container">
                <a class="navbar-brand" href="../..">Mall Docs</a>
                <!-- Expander button -->
                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
                    <span class="navbar-toggler-icon"></span>
                </button>

                <!-- Expanded navigation -->
                <div id="navbar-collapse" class="navbar-collapse collapse">
                        <!-- Main navigation -->
                        <ul class="nav navbar-nav">
                            <li class="navitem">
                                <a href="../.." class="nav-link">Home</a>
                            </li>
                            <li class="dropdown">
                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User <b class="caret"></b></a>
                                <ul class="dropdown-menu">
                                    
<li>
    <a href="../../user/user/" class="dropdown-item">Main</a>
</li>
                                </ul>
                            </li>
                            <li class="dropdown">
                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Mall <b class="caret"></b></a>
                                <ul class="dropdown-menu">
                                    
<li>
    <a href="../../mall/" class="dropdown-item">首页</a>
</li>
                                    
<li>
    <a href="../../mall/coupon/" class="dropdown-item">优惠券</a>
</li>
                                    
<li>
    <a href="../../mall/goods/" class="dropdown-item">产品</a>
</li>
                                    
<li>
    <a href="../../mall/search/" class="dropdown-item">搜索</a>
</li>
                                    
<li>
    <a href="../../mall/cart/" class="dropdown-item">购物车</a>
</li>
                                    
<li>
    <a href="../../mall/address/" class="dropdown-item">地址</a>
</li>
                                    
<li>
    <a href="../../mall/activity/" class="dropdown-item">活动</a>
</li>
                                    
<li>
    <a href="../../mall/order/" class="dropdown-item">订单</a>
</li>
                                    
<li>
    <a href="../../mall/my/" class="dropdown-item">个人中心</a>
</li>
                                    
<li>
    <a href="../../mall/collect/" class="dropdown-item">收藏</a>
</li>
                                    
<li>
    <a href="../../mall/aftersale/" class="dropdown-item">售后</a>
</li>
                                    
<li>
    <a href="../../mall/vip/" class="dropdown-item">会员</a>
</li>
                                    
<li>
    <a href="../../mall/charge/" class="dropdown-item">充值</a>
</li>
                                </ul>
                            </li>
                            <li class="dropdown active">
                                <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">管理后台 <b class="caret"></b></a>
                                <ul class="dropdown-menu">
                                    
<li>
    <a href="./" class="dropdown-item active">用户</a>
</li>
                                    
<li>
    <a href="../goods/" class="dropdown-item">商品</a>
</li>
                                    
<li>
    <a href="../ad/" class="dropdown-item">推广</a>
</li>
                                    
<li>
    <a href="../topic/" class="dropdown-item">活动</a>
</li>
                                </ul>
                            </li>
                        </ul>

                    <ul class="nav navbar-nav ml-auto">
                        <li class="nav-item">
                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
                                <i class="fa fa-search"></i> Search
                            </a>
                        </li>
                            <li class="nav-item">
                                <a rel="prev" href="../../mall/charge/" class="nav-link">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" href="../goods/" class="nav-link">
                                    Next <i class="fa fa-arrow-right"></i>
                                </a>
                            </li>
                    </ul>
                </div>
            </div>
        </div>

        <div class="container">
            <div class="row">
                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
    <div class="navbar-header">
        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
            <span class="fa fa-angle-down"></span>
        </button>
    </div>

    
    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
        <ul class="nav flex-column">
            
            <li class="nav-item" data-level="1"><a href="#_1" class="nav-link">用户管理</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="2"><a href="#_2" class="nav-link">修订记录</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#_3" class="nav-link">背景</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#_4" class="nav-link">产品说明</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#_5" class="nav-link">关键流程说明</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#_6" class="nav-link">接口说明</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
        </ul>
    </div>
</div></div>
                    <div class="col-md-9" role="main">

<h1 id="_1">用户管理</h1>
<div class="toc">
<ul>
<li><a href="#_1">用户管理</a><ul>
<li><a href="#_2">修订记录</a></li>
<li><a href="#_3">背景</a></li>
<li><a href="#_4">产品说明</a></li>
<li><a href="#_5">关键流程说明</a></li>
<li><a href="#_6">接口说明</a><ul>
<li><a href="#10">1.0 用户列表</a><ul>
<li><a href="#_7">接口说明</a></li>
<li><a href="#_8">请求说明</a></li>
<li><a href="#_9">输入参数</a></li>
<li><a href="#_10">错误说明</a></li>
<li><a href="#_11">返回实例</a></li>
</ul>
</li>
<li><a href="#11">1.1 会员管理</a><ul>
<li><a href="#_12">接口说明</a></li>
<li><a href="#_13">请求说明</a></li>
<li><a href="#_14">输入参数</a></li>
<li><a href="#_15">错误说明</a></li>
<li><a href="#_16">返回实例</a></li>
</ul>
</li>
<li><a href="#11_1">1.1 用户足迹</a><ul>
<li><a href="#_17">接口说明</a></li>
<li><a href="#_18">请求说明</a></li>
<li><a href="#_19">输入参数</a></li>
<li><a href="#_20">错误说明</a></li>
<li><a href="#_21">返回实例</a></li>
</ul>
</li>
<li><a href="#12">1.2 员工管理</a><ul>
<li><a href="#_22">接口说明</a></li>
<li><a href="#_23">请求说明</a></li>
<li><a href="#_24">输入参数</a></li>
<li><a href="#_25">错误说明</a></li>
<li><a href="#_26">返回实例</a></li>
</ul>
</li>
<li><a href="#13">1.3 添加员工</a><ul>
<li><a href="#_27">接口说明</a></li>
<li><a href="#_28">请求说明</a></li>
<li><a href="#_29">输入参数</a></li>
<li><a href="#_30">错误说明</a></li>
<li><a href="#_31">返回实例</a></li>
</ul>
</li>
<li><a href="#14">1.4  员工充值</a><ul>
<li><a href="#_32">接口说明</a></li>
<li><a href="#_33">请求说明</a></li>
<li><a href="#_34">输入参数</a></li>
<li><a href="#_35">错误说明</a></li>
<li><a href="#_36">返回实例</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<h2 id="_2">修订记录</h2>
<hr />
<table>
<thead>
<tr>
<th>日期</th>
<th>作者</th>
<th>修订类型</th>
<th>修订内容</th>
<th>版本</th>
</tr>
</thead>
<tbody>
<tr>
<td>2020年07月03日</td>
<td>冷立纲</td>
<td>A</td>
<td>新增设计方案</td>
<td>1.0</td>
</tr>
</tbody>
</table>
<blockquote>
<p>【修订类型：A-新增  M-修改 D-删除】</p>
</blockquote>
<h2 id="_3">背景</h2>
<p>后台用户管理相关接口</p>
<h2 id="_4">产品说明</h2>
<h2 id="_5">关键流程说明</h2>
<h2 id="_6">接口说明</h2>
<h4 id="10">1.0 用户列表</h4>
<h5 id="_7">接口说明</h5>
<p>管理中心用户列表</p>
<h5 id="_8">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">get</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/user/list</td>
</tr>
</tbody>
</table>
<h5 id="_9">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">name</td>
<td align="center">否</td>
<td align="left">strring</td>
<td align="left">用户名</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">uid</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">用户ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">mobile</td>
<td align="center">否</td>
<td align="left">string</td>
<td align="left">手机号</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">page</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">分页</td>
<td align="left">默认1</td>
</tr>
<tr>
<td align="left">limit</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">限制单页条数</td>
<td align="left">默认10</td>
</tr>
</tbody>
</table>
<h5 id="_10">错误说明</h5>
<h5 id="_11">返回实例</h5>
<pre><code class="json">    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {
        &quot;pageSize&quot;: 10,
        &quot;currentPage&quot;: 1,
        &quot;list&quot;: [
            {
                &quot;uid&quot;: 11452,
                &quot;avatar&quot;: &quot;https://wx.qlogo.cn/mmopen/vi_32/DYAIOgq83erWxMXolPylQhpDXp2ian7PBuoDRWGINpdHib4KRB1aQiahicibznMcyj7atEIw9HM98dTQW19xKAWicFog/132&quot;,
                &quot;name&quot;: &quot;狂奔的蜗牛&quot;,
                &quot;gender&quot;: 1,    //性别 1:男  2:女  0:保密
                &quot;birthday&quot;: null,
                &quot;status&quot;: 0,
                &quot;mobile&quot;: null,
                &quot;createTime&quot;: 1595066012848,
                &quot;updateTime&quot;: null,
                &quot;vipStartTime&quot;: null,
                &quot;vipEndTime&quot;: null,
                &quot;userSource&quot;: null, //用户来源 APP:  应用  MINI: 小程序
                &quot;level&quot;: null, //会员等级
                &quot;vipTotalDays&quot;: null, //会员累计天数
                &quot;vip&quot;: false //是否vip
            }
        ],
        &quot;end&quot;: true,
        &quot;empty&quot;: false,
        &quot;startIndex&quot;: 0
    }
}  
</code></pre>

<h4 id="11">1.1 会员管理</h4>
<h5 id="_12">接口说明</h5>
<p>会员条件查询列表</p>
<h5 id="_13">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">get</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/user/vip_list</td>
</tr>
</tbody>
</table>
<h5 id="_14">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">name</td>
<td align="center">否</td>
<td align="left">strring</td>
<td align="left">用户名</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">uid</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">用户ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">mobile</td>
<td align="center">否</td>
<td align="left">string</td>
<td align="left">手机号</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">vipStatus</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">会员状态</td>
<td align="left">0 全部 1 vip 2 已过期</td>
</tr>
<tr>
<td align="left">page</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">分页</td>
<td align="left">默认1</td>
</tr>
<tr>
<td align="left">limit</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">限制单页条数</td>
<td align="left">默认10</td>
</tr>
</tbody>
</table>
<h5 id="_15">错误说明</h5>
<h5 id="_16">返回实例</h5>
<pre><code class="json">    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {
        &quot;pageSize&quot;: 10,
        &quot;currentPage&quot;: 1,
        &quot;list&quot;: [
            {
                &quot;uid&quot;: 11452,
                &quot;avatar&quot;: &quot;https://wx.qlogo.cn/mmopen/vi_32/DYAIOgq83erWxMXolPylQhpDXp2ian7PBuoDRWGINpdHib4KRB1aQiahicibznMcyj7atEIw9HM98dTQW19xKAWicFog/132&quot;,
                &quot;name&quot;: &quot;狂奔的蜗牛&quot;,
                &quot;gender&quot;: 1,    //性别 1:男  2:女  0:保密
                &quot;birthday&quot;: null,
                &quot;status&quot;: 0,
                &quot;mobile&quot;: null,
                &quot;createTime&quot;: 1595066012848,
                &quot;updateTime&quot;: null,
                &quot;vipStartTime&quot;: null,
                &quot;vipEndTime&quot;: null,
                &quot;userSource&quot;: null, //用户来源 APP:  应用  MINI: 小程序
                &quot;level&quot;: null, //会员等级
                &quot;vipTotalDays&quot;: null, //会员累计天数
                &quot;vip&quot;: false, //是否vip
                &quot;buyTimes&quot;: 5 // 会员累计购买次数
            }
        ],
        &quot;end&quot;: true,
        &quot;empty&quot;: false,
        &quot;startIndex&quot;: 0
    }
}  
</code></pre>

<h4 id="11_1">1.1 用户足迹</h4>
<h5 id="_17">接口说明</h5>
<p>用户足迹</p>
<h5 id="_18">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">get</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/footprint/list</td>
</tr>
</tbody>
</table>
<h5 id="_19">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">name</td>
<td align="center">否</td>
<td align="left">strring</td>
<td align="left">用户名</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">uid</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">用户ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">goodsId</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">产品ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">goodsName</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">产品ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">page</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">分页</td>
<td align="left">默认1</td>
</tr>
<tr>
<td align="left">limit</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">限制单页条数</td>
<td align="left">默认10</td>
</tr>
</tbody>
</table>
<h5 id="_20">错误说明</h5>
<h5 id="_21">返回实例</h5>
<pre><code class="json">
    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {
        &quot;pageSize&quot;: 10,
        &quot;currentPage&quot;: 1,
        &quot;list&quot;: [
            {
                &quot;id&quot;: 766,
                &quot;userId&quot;: 11450,
                &quot;goodsId&quot;: 1006002,
                &quot;goodsName&quot;: &quot;产品名称&quot;,
                &quot;addTime&quot;: &quot;2020-07-19 15:17:59&quot;,
                &quot;updateTime&quot;: &quot;2020-07-19 15:17:59&quot;,
                &quot;deleted&quot;: false
            }
        ],
        &quot;end&quot;: true,
        &quot;empty&quot;: false,
        &quot;startIndex&quot;: 0
    }
}

</code></pre>

<h4 id="12">1.2 员工管理</h4>
<h5 id="_22">接口说明</h5>
<p>管理中心用户列表</p>
<h5 id="_23">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">get</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/employee/list</td>
</tr>
</tbody>
</table>
<h5 id="_24">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">name</td>
<td align="center">否</td>
<td align="left">strring</td>
<td align="left">用户名</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">uid</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">用户ID</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">mobile</td>
<td align="center">否</td>
<td align="left">string</td>
<td align="left">手机号</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">employeeType</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">员工类型</td>
<td align="left">1 中标优选</td>
</tr>
<tr>
<td align="left">page</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">分页</td>
<td align="left">默认1</td>
</tr>
<tr>
<td align="left">limit</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">限制单页条数</td>
<td align="left">默认10</td>
</tr>
</tbody>
</table>
<h5 id="_25">错误说明</h5>
<h5 id="_26">返回实例</h5>
<pre><code class="json">
    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {
        &quot;total&quot;: 15,
        &quot;list&quot;: [
            {
                &quot;uid&quot;: 11462, //用户ID
                &quot;avatar&quot;: null, //头像
                &quot;name&quot;: null, // 昵称
                &quot;createTime&quot;: 1595935404952, //创建时间
                &quot;mobile&quot;: &quot;15201008963&quot;,//手机号
                &quot;employeeType&quot;: &quot;&quot;, //员工类型
                &quot;money&quot;: null,  //余额
                &quot;lastChargeMoney&quot;: null, //最后充值金额
                &quot;lastChargeTime&quot;: null //最后充值时间
            }
        ],
        &quot;pageNum&quot;: 1,
        &quot;pageSize&quot;: 10,
        &quot;size&quot;: 0,
        &quot;startRow&quot;: 0,
        &quot;endRow&quot;: 0,
        &quot;pages&quot;: 0,
        &quot;prePage&quot;: 0,
        &quot;nextPage&quot;: 0,
        &quot;isFirstPage&quot;: false,
        &quot;isLastPage&quot;: false,
        &quot;hasPreviousPage&quot;: false,
        &quot;hasNextPage&quot;: false,
        &quot;navigatePages&quot;: 0,
        &quot;navigatepageNums&quot;: null,
        &quot;navigateFirstPage&quot;: 0,
        &quot;navigateLastPage&quot;: 0
    }
}

</code></pre>

<h4 id="13">1.3 添加员工</h4>
<h5 id="_27">接口说明</h5>
<p>管理中心用户列表</p>
<h5 id="_28">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">post</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/employee/create</td>
</tr>
</tbody>
</table>
<h5 id="_29">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">name</td>
<td align="center">是</td>
<td align="left">strring</td>
<td align="left">用户名</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">mobile</td>
<td align="center">是</td>
<td align="left">string</td>
<td align="left">手机号</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">employeeType</td>
<td align="center">否</td>
<td align="left">int</td>
<td align="left">员工类型</td>
<td align="left">1 中标优选</td>
</tr>
</tbody>
</table>
<h5 id="_30">错误说明</h5>
<h5 id="_31">返回实例</h5>
<pre><code class="json">
    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {
       &quot;id&quot;:152 //用户ID
    }
}

</code></pre>

<h4 id="14">1.4  员工充值</h4>
<h5 id="_32">接口说明</h5>
<p>管理中心用户列表</p>
<h5 id="_33">请求说明</h5>
<table>
<thead>
<tr>
<th align="left">http 请求方式</th>
<th align="center">post</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">url</td>
<td align="center">/admin/employee/transfer</td>
</tr>
</tbody>
</table>
<h5 id="_34">输入参数</h5>
<table>
<thead>
<tr>
<th align="left">参数</th>
<th align="center">必选</th>
<th align="left">类型</th>
<th align="left">参数说明</th>
<th align="left">备注</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">uidList</td>
<td align="center">是</td>
<td align="left">int[]</td>
<td align="left">用户列表</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">money</td>
<td align="center">是</td>
<td align="left">double</td>
<td align="left">转账金额</td>
<td align="left"></td>
</tr>
<tr>
<td align="left">reason</td>
<td align="center">是</td>
<td align="left">string</td>
<td align="left">转账说明</td>
<td align="left"></td>
</tr>
</tbody>
</table>
<h5 id="_35">错误说明</h5>
<h5 id="_36">返回实例</h5>
<pre><code class="json">
    {
    &quot;c&quot;: 0,
    &quot;m&quot;: null,
    &quot;d&quot;: {

    }
}

</code></pre></div>
            </div>
        </div>

        <footer class="col-md-12">
            <hr>
            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
        </footer>
        <script>
            var base_url = "../..",
                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
        </script>
        <script src="../../js/base.js" defer></script>
        <script src="../../search/main.js" defer></script>

        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
    <div class="modal-dialog modal-lg">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="searchModalLabel">Search</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
                <p>
                    From here you can search these documents. Enter
                    your search terms below.
                </p>
                <form>
                    <div class="form-group">
                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
                    </div>
                </form>
                <div id="mkdocs-search-results"></div>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
    <div class="modal-dialog">
        <div class="modal-content">
            <div class="modal-header">
                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
            </div>
            <div class="modal-body">
              <table class="table">
                <thead>
                  <tr>
                    <th style="width: 20%;">Keys</th>
                    <th>Action</th>
                  </tr>
                </thead>
                <tbody>
                  <tr>
                    <td class="help shortcut"><kbd>?</kbd></td>
                    <td>Open this help</td>
                  </tr>
                  <tr>
                    <td class="next shortcut"><kbd>n</kbd></td>
                    <td>Next page</td>
                  </tr>
                  <tr>
                    <td class="prev shortcut"><kbd>p</kbd></td>
                    <td>Previous page</td>
                  </tr>
                  <tr>
                    <td class="search shortcut"><kbd>s</kbd></td>
                    <td>Search</td>
                  </tr>
                </tbody>
              </table>
            </div>
            <div class="modal-footer">
            </div>
        </div>
    </div>
</div>

    </body>
</html>
